Skip to main content

/sale

Request body:

FieldTypeRequiredFormat / constraints
documentIDinteger (int64)NoInternal document id
documentExtIDstringNoExternal document id
docTimestringNoyyyy-MM-dd HH:mm:ss
docNumberstringNoExternal document number
wsNamestringNoWorkstation name
departmentNamestringNoStore/department name
departmentCodestringNoStore/department code
employeeNamestringNoCashier name
employeeFirstNamestringNoUsed when employeeName is empty
employeeLastNamestringNoUsed when employeeName is empty
itemsarray of item objectsYesMust be non-empty
paymentsobjectNoPayment split object
extraPaymentsarray of extra payment objectsNoAdditional payment entries

Success response:

FieldTypeRequiredNotes
documentIDinteger (int64)NoInternal document id
fiscalIDstringNoFiscal document id
fiscalNumstringNoFiscal document number
fiscalUrlstringNoFiscal URL
docTimestringNoyyyy-MM-dd HH:mm:ss
printTimestringNoyyyy-MM-dd HH:mm:ss
docStatusinteger (int32)NoSee value map below
rrnstringNoCard terminal RRN
authstringNoAuthorization code
cardNumstringNoCard number (masked)
checkNumstringNoTerminal check number
printErrorinteger (int32)NoPrint error code
totalPaymentsarray of payment entriesNoPayment breakdown
currency_namestringNoCurrency
documentExtIDstringNoExternal document id

Specific values:

  • docStatus: 0 = open, 1 = closed.